﻿//-----------------------------------------------------------------------
// <copyright file="IPublishedException.cs" company="CodePlex">
//     Copyright (c) Doug Holland, CodePlex. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
namespace CodePlex.Diagnostics
{
    using System;
    
    using System.Diagnostics.CodeAnalysis;

    /// <summary>
    /// Defines the contract for published exception types within the CodePlex.Diagnostics framework.
    /// </summary>
    [SuppressMessage("Microsoft.Naming", "CA1711:IdentifiersShouldNotHaveIncorrectSuffix", Justification = "The IPublishedException interface is intended to be realized only by exception types and is therefore named accordingly.")]
    internal interface IPublishedException
    {
        #region Guid PublicationId

        /// <summary>
        /// Gets the publication Id associated with the <see cref="M:System.Exception.InnerException"/>.
        /// </summary>
        Guid PublicationId
        {
            get;
        }

        #endregion
    }
}